cmd/anubis: allow setting key bytes in flag/envvar#97
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enables setting ed25519 signing keys via a flag or environment variable while updating documentation and deployment configuration. Key changes include:
- Adding a React component that generates and displays a random key with a refresh button.
- Introducing a new flag (and associated logic) in the Go code to load or generate ed25519 keys.
- Updating the CHANGELOG and deployment manifest with the corresponding new functionality and image tag.
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/components/RandomKey/index.tsx | Added a component to generate and refresh a random signing key. |
| docs/docs/CHANGELOG.md | Updated the changelog to include details about the new key setting option. |
| cmd/anubis/main.go | Integrated key loading/generation logic with flag support and error handling. |
| lib/anubis.go | Updated the New function to incorporate optional ed25519 key usage. |
| docs/manifest/deployment.yaml | Changed the image tag from "latest" to "main". |
Files not reviewed (1)
- docs/docs/admin/installation.mdx: Language not supported
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enables setting the ED25519 private key via a flag or environment variable, while updating both key generation logic and documentation accordingly.
- Added a React component for displaying and regenerating a random key in the docs.
- Introduced a new flag (and corresponding environment variable) to allow specifying the ED25519 private key in hex format and updated key handling in both cmd and lib.
- Updated the CHANGELOG and deployment manifest to reflect these changes.
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/src/components/RandomKey/index.tsx | Added a component that generates and displays a random key with a refresh button. |
| cmd/anubis/main.go | Added flag handling for an ED25519 private key in hex and incorporated key conversion logic with appropriate logging for key generation. |
| docs/docs/CHANGELOG.md | Documented the new flag functionality and key handling behavior. |
| lib/anubis.go | Refactored key generation to use an optional provided private key via options. |
| docs/manifest/deployment.yaml | Updated the image tag reference from latest to main. |
Files not reviewed (1)
- docs/docs/admin/installation.mdx: Language not supported
Comments suppressed due to low confidence (2)
docs/src/components/RandomKey/index.tsx:12
- [nitpick] Consider using the primitive type 'string' instead of 'String' for consistency with TypeScript best practices.
export const genRandomKey = (): String => {
docs/src/components/RandomKey/index.tsx:22
- [nitpick] Consider using 'string' instead of 'String' in the useState generic type to avoid unintended behavior with boxed type objects.
const [key, setKey] = useState<String>(genRandomKey());
2 tasks
robbat2
approved these changes
Mar 24, 2025
ryanccn
reviewed
Mar 25, 2025
Contributor
ryanccn
left a comment
ryanccn
left a comment
There was a problem hiding this comment.
Not exactly sure why the refresh button is currently implemented in this roundabout fashion, but I feel like using useCallback (or even just a plain function) would be a more efficient way of updating the random key.
Docs are updated to generate a random key on load and when people press the recycle button. Signed-off-by: Xe Iaso <me@xeiaso.net>
Signed-off-by: Xe Iaso <me@xeiaso.net>
Signed-off-by: Xe Iaso <me@xeiaso.net>
Co-authored-by: Ryan Cao <70191398+ryanccn@users.noreply.github.com> Signed-off-by: Xe Iaso <me@xeiaso.net>
Xe
force-pushed
the
Xe/key-bytes-in-flag
branch
from
e43e487 to
2e080d2
Compare
JasonLovesDoggo
pushed a commit
to JasonLovesDoggo/anubis
that referenced
this pull request
Jun 17, 2025
* cmd/anubis: allow setting key bytes in flag/envvar Docs are updated to generate a random key on load and when people press the recycle button. Signed-off-by: Xe Iaso <me@xeiaso.net> * review feedback fixups Signed-off-by: Xe Iaso <me@xeiaso.net> * Update cmd/anubis/main.go Signed-off-by: Xe Iaso <me@xeiaso.net> * Apply suggestions from code review Co-authored-by: Ryan Cao <70191398+ryanccn@users.noreply.github.com> Signed-off-by: Xe Iaso <me@xeiaso.net> --------- Signed-off-by: Xe Iaso <me@xeiaso.net> Co-authored-by: Ryan Cao <70191398+ryanccn@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs are updated to generate a random key on load and when people press the recycle button.
Closes #70
Closes #32
Checklist:
[Unreleased]section of docs/docs/CHANGELOG.md